/*
 * Copyright 2007 Yusuke Yamamoto
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package twitter4j;

import java.io.Serializable;

/**
 * Super interface of Twitter Response data interfaces which indicates that rate
 * limit status is avaialble.
 * 
 * @author Yusuke Yamamoto - yusuke at mac.com
 * @see twitter4j.DirectMessage
 * @see twitter4j.Status
 * @see twitter4j.User
 */
public interface TwitterResponse extends Serializable {
	int NONE = 0;

	int READ = 1;

	int READ_WRITE = 2;
	int READ_WRITE_DIRECTMESSAGES = 3;

	/**
	 * @return application permission model
	 * @see <a
	 *      href="https://dev.twitter.com/pages/application-permission-model-faq#how-do-we-know-what-the-access-level-of-a-user-token-is">Application
	 *      Permission Model FAQ - How do we know what the access level of a
	 *      user token is?</a>
	 * @since Twitter4J 2.2.3
	 */
	int getAccessLevel();

	/**
	 * Returns the current rate limit status if available.
	 * 
	 * @return current rate limit status
	 * @since Twitter4J 2.1.0
	 */
	RateLimitStatus getRateLimitStatus();

}
